Eclipse Platform
Pre-release 3.0

Package org.eclipse.jface.text.source

Provides a framework for connecting document regions with annotations and for displaying those annotations in combination with an ITextViewer.

See:
          Description

Interface Summary
IAnnotationAccess An annotation access provides access to information that is not available via the API of Annotation.
IAnnotationAccessExtension Extension interface for IAnnotationAccess.
IAnnotationHover Provides the information to be displayed in a hover popup window which appears over the presentation area of annotations.
IAnnotationHoverExtension Extension to IAnnotationHover for providing its own information control creator providing the range of lines for which the hover for a given line is valid
IAnnotationModel This interface defines the model for managing annotations attached to a document.
IAnnotationModelExtension Extends IAnnotationModel with the ability to attach additional annotation models to it.
IAnnotationModelListener Interface for objects interested in getting informed about annotation model changes.
IAnnotationModelListenerExtension Extension interface for IAnnotationModelListener.
IAnnotationPresentation Interface for annotations that know how to represent themselves.
IChangeRulerColumn An IChangeRulerColumn can display quick diff information.
ICharacterPairMatcher A character pair matcher finds to a character at a certain document offset the matching peer character.
ILineDiffer Protocol that allows direct access to line information.
ILineDiffInfo Describes the change state of one line, which consists of the state of the line itself, which can be UNCHANGED, CHANGED or ADDED, and the number of deleted lines before and after this line.
IOverviewRuler This interface defines a visual component which may serve text viewers as an overview annotation presentation area.
ISharedTextColors Manages SWT color objects.
ISourceViewer In addition to the text viewer functionality a source viewer supports: visual annotations based on an annotation model visual range indication management of text viewer add-ons explicit configuration It is assumed that range indication and visual annotations are shown inside the same presentation area.
ISourceViewerExtension Extension interface for ISourceViewer.
ITagHandler A tag handler is responsible to - handle the attributes for the tags it supports - translate the tag sequence including attributes to another language - back-translate relative line offsets.
ITagHandlerFactory A tag handler factory provides access to tag handlers.
ITranslator A translator translates a given file into another language.
ITranslatorResultCollector Tagging interface for a translator result collector.
IVerticalRuler This interface defines a visual component which may serve text viewers as an annotation presentation area.
IVerticalRulerColumn A IVerticalRulerColumn is an element that can be added to a composite vertical ruler.
IVerticalRulerExtension Extension interface for IVerticalRuler.
IVerticalRulerInfo A vertical ruler is a visual component which may serve text viewers as an annotation presentation area.
IVerticalRulerInfoExtension Extends IVerticalRulerInfo with the ability to define a custom hover to be used when hovering over the IVerticalRuler described by this info instance, and to specify the IAnnotationModel used by it.
 

Class Summary
Annotation Annotation managed by an IAnnotationModel.
AnnotationBarHoverManager This manager controls the layout, content, and visibility of an information control in reaction to mouse hover events issued by the vertical ruler of a source viewer.
AnnotationColumn Deprecated. use AnnotationRulerColumn instead.
AnnotationModel Standard implementation of IAnnotationModel.
AnnotationModelEvent Specification of changes applied to annotation models.
AnnotationPainter Paints annotations provided by an annotation model as squiggly lines and/or highlighted onto an associated source viewer.
AnnotationRulerColumn A vertical ruler column showing graphical representations of annotations.
ChangeRulerColumn A vertical ruler column displaying line numbers and serving as a UI for quick diff.
CompositeRuler Standard implementation of IVerticalRuler.
LineChangeHover A hover for line oriented diffs.
LineNumberChangeRulerColumn A vertical ruler column displaying line numbers and serving as a UI for quick diff.
LineNumberRulerColumn A vertical ruler column displaying line numbers.
MatchingCharacterPainter Highlights the peer character matching the character near the caret position.
OutlinerRulerColumn A ruler column for controlling the behavior of a ProjectionSourceViewer.
OverviewRuler Ruler presented next to a source viewer showing all annotations of the viewer's annotation model in a compact format.
ProjectionAnnotation Annotation used to represent the projection of a master document onto a ProjectionDocument.
ProjectionSourceViewer A projection source viewer is a source viewer which does not support the concept of a visible region.
SourceViewer SWT based implementation of ISourceViewer.
SourceViewerConfiguration This class bundles the whole configuration space of a source viewer.
TagHandlerFactory Default implementation of a tag handler factory
VerticalRuler A vertical ruler which is connected to a text viewer.
 

Package org.eclipse.jface.text.source Description

Provides a framework for connecting document regions with annotations and for displaying those annotations in combination with an ITextViewer. ISourceViewer combines annotation support and all text viewer add-ons.

Package Specification

 ISourceViewer defines the concept of a document based, editable viewer supporting visual annotations. ISourceViewer supports document-specific and viewer-specific annotations attached to the viewer's input document. An ISourceViewer uses an IAnnotationModel to manage annotations and to inform implementers of IAnnotationModelListener about changes in respect to annotations. An IVerticalRuler represents an IAnnotationModel access adapter for an SWT widget capapble of display annotations.  This package also provides default implementations for all defined interfaces.
 


Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.